List subscriptions

Returns all subscriptions available in the tenant along with their associated license bundles and usage details.

GET{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/subscriptions

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Responses

200 - Successful retrieval of Subscription information

json

[
  {
    "subscriptionId": "1724156779826",
    "subscriptionName": "1724156779826",
    "startDate": "2024-08-20 12:26:19",
    "endDate": "2025-08-20 12:26:19",
    "subscriptionType": "Commercial",
    "licenseBundles": [
      {
        "licenseBundleId": 1,
        "products": [
          "WEB",
          "API"
        ],
        "totalLicenses": 10,
        "assignedLicenses": 3,
        "availableLicenses": 7
      },
      {
        "licenseBundleId": 3,
        "products": [
          "MOBILE",
          "API"
        ],
        "totalLicenses": 5,
        "assignedLicenses": 4,
        "availableLicenses": 1
      }
    ]
  }
]

403 - Forbidden - User does not have permission to view subscriptions

json

{
  "error": "User does not have authorization to access this feature"
}

500 - Internal Server Error

json

{
  "error": "Error occurred while retrieving Subscription information."
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X GET "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/subscriptions" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"